<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>py3dtilers.Common.polygon_extrusion API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>py3dtilers.Common.polygon_extrusion</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">import numpy as np
from ..Common import Feature
from alphashape import alphashape
from earclip import triangulate
from shapely.geometry import Polygon
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from ..Common import FeatureList


class ExtrudedPolygon(Feature):
    def __init__(self, id, features: &#39;FeatureList&#39;, polygon=None):
        &#34;&#34;&#34;
        Creates a 3D extrusion of the footprint of a list of features.
        The height and the altitude of the 3D model will be computed using the triangles of the features.
        If a polygon is given, it will be extruded instead of the footprint.
        :param id: the ID of the instance
        :param features: a list of features
        :param polygon: the polygon that will be extruded instead of the footprint
        &#34;&#34;&#34;
        super().__init__(id)
        self.polygon = polygon
        self.features = features
        self.set_geom()

    def set_geom(self):
        &#34;&#34;&#34;
        Set the geometry of the feature.
        :return: a boolean
        &#34;&#34;&#34;
        geom_triangles = list()
        for feature in self.features:
            geom_triangles.extend(feature.get_geom_as_triangles())

        points = list()
        minZ = np.Inf
        average_maxZ = 0

        # Compute the footprint of the geometry
        for triangle in geom_triangles:
            maxZ = np.NINF
            for point in triangle:
                if len(point) &gt;= 3:
                    points.append([point[0], point[1]])
                    if point[2] &lt; minZ:
                        minZ = point[2]
                    if point[2] &gt; maxZ:
                        maxZ = point[2]
            average_maxZ += maxZ
        average_maxZ /= len(geom_triangles)
        if self.polygon is not None:
            points = self.polygon
        else:
            hull = alphashape(points, 0.)
            try:
                points = hull.exterior.coords[:-1]
            except AttributeError:
                po = hull.parallel_offset(0.1, &#39;right&#39;)
                points = Polygon([*list(hull.coords), *list(po.coords)[::-1]]).exterior.coords[:-1]

        self.points = points
        self.min_height = minZ
        self.max_height = average_maxZ

        self.extrude_footprint()

    def extrude_footprint(self):
        &#34;&#34;&#34;
        Extrude the 2D footprint to create a triangulated 3D mesh.
        &#34;&#34;&#34;
        coordinates = self.points
        length = len(coordinates)
        vertices = [None] * (2 * length)
        minZ = self.min_height
        maxZ = self.max_height

        for i, coord in enumerate(coordinates):
            vertices[i] = np.array([coord[0], coord[1], minZ])
            vertices[i + length] = np.array([coord[0], coord[1], maxZ])

        # Contains the triangles vertices. Used to create 3D tiles
        triangles = list()

        # Triangulate the feature footprint
        poly_triangles = triangulate(coordinates)

        # Create upper face triangles
        for tri in poly_triangles:
            upper_tri = [np.array([coord[0], coord[1], maxZ]) for coord in tri]
            triangles.append(upper_tri)

        # Create side triangles
        for i in range(0, length):
            triangles.append([vertices[i], vertices[length + i], vertices[length + ((i + 1) % length)]])
            triangles.append([vertices[i], vertices[length + ((i + 1) % length)], vertices[((i + 1) % length)]])

        self.feature_list = None
        self.geom.triangles.append(triangles)
        self.set_box()</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="py3dtilers.Common.polygon_extrusion.ExtrudedPolygon"><code class="flex name class">
<span>class <span class="ident">ExtrudedPolygon</span></span>
<span>(</span><span>id, features: FeatureList, polygon=None)</span>
</code></dt>
<dd>
<div class="desc"><p>The base class of all object that need to be tiled, in order to be
used with the corresponding tiler.</p>
<p>Creates a 3D extrusion of the footprint of a list of features.
The height and the altitude of the 3D model will be computed using the triangles of the features.
If a polygon is given, it will be extruded instead of the footprint.
:param id: the ID of the instance
:param features: a list of features
:param polygon: the polygon that will be extruded instead of the footprint</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class ExtrudedPolygon(Feature):
    def __init__(self, id, features: &#39;FeatureList&#39;, polygon=None):
        &#34;&#34;&#34;
        Creates a 3D extrusion of the footprint of a list of features.
        The height and the altitude of the 3D model will be computed using the triangles of the features.
        If a polygon is given, it will be extruded instead of the footprint.
        :param id: the ID of the instance
        :param features: a list of features
        :param polygon: the polygon that will be extruded instead of the footprint
        &#34;&#34;&#34;
        super().__init__(id)
        self.polygon = polygon
        self.features = features
        self.set_geom()

    def set_geom(self):
        &#34;&#34;&#34;
        Set the geometry of the feature.
        :return: a boolean
        &#34;&#34;&#34;
        geom_triangles = list()
        for feature in self.features:
            geom_triangles.extend(feature.get_geom_as_triangles())

        points = list()
        minZ = np.Inf
        average_maxZ = 0

        # Compute the footprint of the geometry
        for triangle in geom_triangles:
            maxZ = np.NINF
            for point in triangle:
                if len(point) &gt;= 3:
                    points.append([point[0], point[1]])
                    if point[2] &lt; minZ:
                        minZ = point[2]
                    if point[2] &gt; maxZ:
                        maxZ = point[2]
            average_maxZ += maxZ
        average_maxZ /= len(geom_triangles)
        if self.polygon is not None:
            points = self.polygon
        else:
            hull = alphashape(points, 0.)
            try:
                points = hull.exterior.coords[:-1]
            except AttributeError:
                po = hull.parallel_offset(0.1, &#39;right&#39;)
                points = Polygon([*list(hull.coords), *list(po.coords)[::-1]]).exterior.coords[:-1]

        self.points = points
        self.min_height = minZ
        self.max_height = average_maxZ

        self.extrude_footprint()

    def extrude_footprint(self):
        &#34;&#34;&#34;
        Extrude the 2D footprint to create a triangulated 3D mesh.
        &#34;&#34;&#34;
        coordinates = self.points
        length = len(coordinates)
        vertices = [None] * (2 * length)
        minZ = self.min_height
        maxZ = self.max_height

        for i, coord in enumerate(coordinates):
            vertices[i] = np.array([coord[0], coord[1], minZ])
            vertices[i + length] = np.array([coord[0], coord[1], maxZ])

        # Contains the triangles vertices. Used to create 3D tiles
        triangles = list()

        # Triangulate the feature footprint
        poly_triangles = triangulate(coordinates)

        # Create upper face triangles
        for tri in poly_triangles:
            upper_tri = [np.array([coord[0], coord[1], maxZ]) for coord in tri]
            triangles.append(upper_tri)

        # Create side triangles
        for i in range(0, length):
            triangles.append([vertices[i], vertices[length + i], vertices[length + ((i + 1) % length)]])
            triangles.append([vertices[i], vertices[length + ((i + 1) % length)], vertices[((i + 1) % length)]])

        self.feature_list = None
        self.geom.triangles.append(triangles)
        self.set_box()</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="py3dtilers.Common.feature.Feature" href="feature.html#py3dtilers.Common.feature.Feature">Feature</a></li>
</ul>
<h3>Methods</h3>
<dl>
<dt id="py3dtilers.Common.polygon_extrusion.ExtrudedPolygon.extrude_footprint"><code class="name flex">
<span>def <span class="ident">extrude_footprint</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Extrude the 2D footprint to create a triangulated 3D mesh.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def extrude_footprint(self):
    &#34;&#34;&#34;
    Extrude the 2D footprint to create a triangulated 3D mesh.
    &#34;&#34;&#34;
    coordinates = self.points
    length = len(coordinates)
    vertices = [None] * (2 * length)
    minZ = self.min_height
    maxZ = self.max_height

    for i, coord in enumerate(coordinates):
        vertices[i] = np.array([coord[0], coord[1], minZ])
        vertices[i + length] = np.array([coord[0], coord[1], maxZ])

    # Contains the triangles vertices. Used to create 3D tiles
    triangles = list()

    # Triangulate the feature footprint
    poly_triangles = triangulate(coordinates)

    # Create upper face triangles
    for tri in poly_triangles:
        upper_tri = [np.array([coord[0], coord[1], maxZ]) for coord in tri]
        triangles.append(upper_tri)

    # Create side triangles
    for i in range(0, length):
        triangles.append([vertices[i], vertices[length + i], vertices[length + ((i + 1) % length)]])
        triangles.append([vertices[i], vertices[length + ((i + 1) % length)], vertices[((i + 1) % length)]])

    self.feature_list = None
    self.geom.triangles.append(triangles)
    self.set_box()</code></pre>
</details>
</dd>
<dt id="py3dtilers.Common.polygon_extrusion.ExtrudedPolygon.set_geom"><code class="name flex">
<span>def <span class="ident">set_geom</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Set the geometry of the feature.
:return: a boolean</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def set_geom(self):
    &#34;&#34;&#34;
    Set the geometry of the feature.
    :return: a boolean
    &#34;&#34;&#34;
    geom_triangles = list()
    for feature in self.features:
        geom_triangles.extend(feature.get_geom_as_triangles())

    points = list()
    minZ = np.Inf
    average_maxZ = 0

    # Compute the footprint of the geometry
    for triangle in geom_triangles:
        maxZ = np.NINF
        for point in triangle:
            if len(point) &gt;= 3:
                points.append([point[0], point[1]])
                if point[2] &lt; minZ:
                    minZ = point[2]
                if point[2] &gt; maxZ:
                    maxZ = point[2]
        average_maxZ += maxZ
    average_maxZ /= len(geom_triangles)
    if self.polygon is not None:
        points = self.polygon
    else:
        hull = alphashape(points, 0.)
        try:
            points = hull.exterior.coords[:-1]
        except AttributeError:
            po = hull.parallel_offset(0.1, &#39;right&#39;)
            points = Polygon([*list(hull.coords), *list(po.coords)[::-1]]).exterior.coords[:-1]

    self.points = points
    self.min_height = minZ
    self.max_height = average_maxZ

    self.extrude_footprint()</code></pre>
</details>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="py3dtilers.Common.feature.Feature" href="feature.html#py3dtilers.Common.feature.Feature">Feature</a></b></code>:
<ul class="hlist">
<li><code><a title="py3dtilers.Common.feature.Feature.get_batchtable_data" href="feature.html#py3dtilers.Common.feature.Feature.get_batchtable_data">get_batchtable_data</a></code></li>
<li><code><a title="py3dtilers.Common.feature.Feature.get_bounding_volume_box" href="feature.html#py3dtilers.Common.feature.Feature.get_bounding_volume_box">get_bounding_volume_box</a></code></li>
<li><code><a title="py3dtilers.Common.feature.Feature.get_centroid" href="feature.html#py3dtilers.Common.feature.Feature.get_centroid">get_centroid</a></code></li>
<li><code><a title="py3dtilers.Common.feature.Feature.get_geom" href="feature.html#py3dtilers.Common.feature.Feature.get_geom">get_geom</a></code></li>
<li><code><a title="py3dtilers.Common.feature.Feature.get_geom_as_triangles" href="feature.html#py3dtilers.Common.feature.Feature.get_geom_as_triangles">get_geom_as_triangles</a></code></li>
<li><code><a title="py3dtilers.Common.feature.Feature.get_id" href="feature.html#py3dtilers.Common.feature.Feature.get_id">get_id</a></code></li>
<li><code><a title="py3dtilers.Common.feature.Feature.get_texture" href="feature.html#py3dtilers.Common.feature.Feature.get_texture">get_texture</a></code></li>
<li><code><a title="py3dtilers.Common.feature.Feature.has_texture" href="feature.html#py3dtilers.Common.feature.Feature.has_texture">has_texture</a></code></li>
<li><code><a title="py3dtilers.Common.feature.Feature.set_batchtable_data" href="feature.html#py3dtilers.Common.feature.Feature.set_batchtable_data">set_batchtable_data</a></code></li>
<li><code><a title="py3dtilers.Common.feature.Feature.set_box" href="feature.html#py3dtilers.Common.feature.Feature.set_box">set_box</a></code></li>
<li><code><a title="py3dtilers.Common.feature.Feature.set_id" href="feature.html#py3dtilers.Common.feature.Feature.set_id">set_id</a></code></li>
<li><code><a title="py3dtilers.Common.feature.Feature.set_texture" href="feature.html#py3dtilers.Common.feature.Feature.set_texture">set_texture</a></code></li>
<li><code><a title="py3dtilers.Common.feature.Feature.set_triangles" href="feature.html#py3dtilers.Common.feature.Feature.set_triangles">set_triangles</a></code></li>
</ul>
</li>
</ul>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="py3dtilers.Common" href="index.html">py3dtilers.Common</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="py3dtilers.Common.polygon_extrusion.ExtrudedPolygon" href="#py3dtilers.Common.polygon_extrusion.ExtrudedPolygon">ExtrudedPolygon</a></code></h4>
<ul class="">
<li><code><a title="py3dtilers.Common.polygon_extrusion.ExtrudedPolygon.extrude_footprint" href="#py3dtilers.Common.polygon_extrusion.ExtrudedPolygon.extrude_footprint">extrude_footprint</a></code></li>
<li><code><a title="py3dtilers.Common.polygon_extrusion.ExtrudedPolygon.set_geom" href="#py3dtilers.Common.polygon_extrusion.ExtrudedPolygon.set_geom">set_geom</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>